/**
 * pharma-model - 9 janv. 2011 guillaume
 */
package org.bspv.pharma.model;

import java.io.Serializable;
import java.util.Date;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Inheritance;
import javax.persistence.InheritanceType;
import javax.persistence.ManyToOne;
import javax.persistence.Table;
import javax.persistence.Version;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

import org.bspv.pharma.common.constant.Constants;

/**
 * @author guillaume
 */
@Entity
@Table(name = "EVENT")
@Inheritance(strategy = InheritanceType.JOINED)
public class Event implements Serializable {

    /**
     * serialVersionUID.
     */
    private static final long serialVersionUID = 1L;

    /**
     * @author guillaume Enumération représentant l'état de la commande.
     */
    public static enum EventTypeEnum {
        /**
         * Evénement générique.
         */
        GENERIC,
        /**
         * Evénement de création d'une commande.
         */
        ORDER_CREATION,
        /**
         * Evénement d'annulation d'une commande.
         */
        ORDER_CANCELLATION,
        /**
         * Evénement de clôture d'une commande.
         */
        ORDER_CLOSING,
        /**
         * Evénement de correction d'une commande.
         */
        ORDER_CORRECTION,
        /**
         * Evénement de suppression d'une commande.
         */
        ORDER_DELETION,
        /**
         * Evénement de livraison d'une commande.
         */
        ORDER_DELIVERY,
        /**
         * Evénement d'envoi d'une commande.
         */
        ORDER_SENDING,
        /**
         * Evénement de consommation d'un consommable.
         */
        CONSUMPTION,
        /**
         * Evénement de déplacement d'une fourniture.
         */
        MOVE;
    }

    /**
     * Identifiant de l'évènement.
     */
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;
    /**
     * Date de l'évènement.
     */
    @NotNull
    private Date date;
    /**
     * Utilisateur responsable de cet évènement.
     */
    @ManyToOne
    private User user;
    /**
     * Commentaire sur cet évènement.
     */
    @Size(max = Constants.CONSTRAINT_COMMENT_SIZE)
    private String comment;
    /**
     * Numéro de version.
     */
    @Version
    private Integer version;

    /**
     * @return the id
     */
    public final Long getId() {
        return id;
    }

    /**
     * @param id
     *            the id to set
     */
    public final void setId(final Long id) {
        this.id = id;
    }

    /**
     * @return the date
     */
    public final Date getDate() {
        return date;
    }

    /**
     * @param date
     *            the date to set
     */
    public final void setDate(final Date date) {
        this.date = date;
    }

    /**
     * @return the user
     */
    public final User getUser() {
        return user;
    }

    /**
     * @param user
     *            the user to set
     */
    public final void setUser(final User user) {
        this.user = user;
    }

    /**
     * @return the eventType
     */
    public EventTypeEnum getEventType() {
        return EventTypeEnum.GENERIC;
    }

    /**
     * @return the comment
     */
    public final String getComment() {
        return comment;
    }

    /**
     * @param comment
     *            the comment to set
     */
    public final void setComment(final String comment) {
        this.comment = comment;
    }

    /**
     * @return the version
     */
    public final Integer getVersion() {
        return version;
    }

    /**
     * @param version
     *            the version to set
     */
    public final void setVersion(final Integer version) {
        this.version = version;
    }

}
